//
// OpenTemplate
// Copyright (c) 2006
// by OpenArrow Software ( http://www.openarrow.com )
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
// documentation files (the "Software"), to deal in the Software without restriction, including without limitation 
// the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and 
// to permit persons to whom the Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or substantial portions 
// of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED 
// TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF 
// CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
// DEALINGS IN THE SOFTWARE.
//

using System;
using System.Collections.Generic;
using System.Text;
using System.IO;
using OpenArrow.Reporting;

namespace OpenArrow.Templating
{
    /// <summary>
    /// Provides an interface to an OpenArrow Template
    /// </summary>
    public interface ITemplate
    {       
        /// <summary>
        /// Renders the template to the specified output stream.
        /// </summary>
        /// <remarks>This method reports its progress to a given progress reporter</remarks>
        /// <param name="output">The <see cref="System.IO.Stream"/> to render the template to.</param>
        /// <param name="reporter">A progress reporter to use</param>
        /// <exception cref="ArgumentNullException"><paramref name="output"/> is <see langword="null"/></exception>
        void Render(Stream output, IProgressReporter reporter);

        /// <summary>
        /// Renders the template to the specified <see cref="TextWriter"/>
        /// </summary>
        /// <remarks>This method reports its progress to a given progress reporter</remarks>
        /// <param name="output">The <see cref="TextWriter"/> to render the template to.</param>
        /// <param name="reporter">A progress reporter to use</param>
        /// <exception cref="ArgumentNullException"><paramref name="output"/> is <see langword="null"/></exception>
        void Render(TextWriter output, IProgressReporter reporter);
    }
}
